Improve Plugin Playground Documentation and Visuals - #151
Conversation
|
Preview environments for this pull request:
|
krassowski
left a comment
krassowski
left a comment
There was a problem hiding this comment.
I think it is a great, see some minor suggestions. I will ask copilot to scan for typos.
There was a problem hiding this comment.
Pull request overview
This PR enhances the Plugin Playground documentation by adding clearer “feature highlight”/workflow guidance and embedding Playwright/Galata-generated screenshots, along with the tooling needed to regenerate them.
Changes:
- Add a dedicated Playwright/Galata spec to generate README screenshots and store them under
docs/images/readme/. - Update Playwright configs and npm scripts to exclude screenshot generation from normal UI test runs while enabling an explicit
docs:screenshotsworkflow. - Refresh/expand
README.mdsections (feature highlights, command insert modes, command APIs, advanced settings) and wire README inclusion in docs.
Reviewed changes
Copilot reviewed 8 out of 15 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| ui-tests/tests/readme-screenshots.spec.ts | New serial Galata test that drives the UI and saves README screenshots to docs/images/readme. |
| ui-tests/playwright.docs.config.js | New Playwright config that only runs the README screenshot spec. |
| ui-tests/playwright.config.js | Excludes the screenshot spec from default UI test runs. |
| ui-tests/package.json | Adds test:docs-screenshots script. |
| ui-tests/README.md | Documents how to run the screenshot generation script. |
| package.json | Adds docs:screenshots root-level script for regeneration. |
| README.md | Major doc refresh + embeds generated screenshots and updates command/settings documentation. |
| docs/index.md | Adjusts README inclusion options for docs site rendering. |
| docs/images/readme/*.png | Adds generated screenshots referenced by the README. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 17 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Closes #146
This PR improves the Plugin Playground documentation to make it clearer, more complete, and easier to follow for new and existing users. It refreshes wording where needed and adds in-context screenshots so readers can quickly understand key workflows and verify what they should see in the interface.